Pular para o conteúdo principal

Formulário de Desvio

Para efetuar o upload de um documento do tipo Formulário de Desvio, basta enviar uma requisição POST conforme demonstrado abaixo. O seu código interno é o 27.

POST URL Ambiente/api_document/documents/upload

IdentificadorValor
Content-typeapplication/json
Acceptapplication/json
X-API-KEY[api_key]

Payload​

ParâmetroDescriçãoObrigatórioTipoExemplos
fileConteúdo em base64 do documentoSimString"iVBORw0KGgoAAAAN..."
fileTypeTipo do arquivo do documento enviadoSimString"pdf"
typeTipo do documento enviadoSimInteger27
pagesPáginas a serem analisadas (Quando extensão for pdf)NãoString"1,2,5-10"

Exemplo​

{
  "file": "iVBORw0KGgoAAAANSUhEUgAABHIAAAM+...",
  "fileType": "pdf",
  "type": 27,
  "pages": "1,2,5-10"
}

Retorno​

Status code 200​

Ao enviar um documento, o retorno 200 dado pela api, irá enviar um objeto data nulo pois a inferência do documento ainda será feita. Para obter o resultado da Inteligência Artificial, é necessário utilizar a requisição vista na próxima sessão.

ParâmetroDescriçãoTipoExemplos
idCódigo interno do documentoUUID"95893394-337c-429c-..."
statusSituação do documento (0-Received, 1-Finished, 2-Error, 3-In Progress)Integer1
statusDescSituação do documento (RECEIVED, FINISHED, IN_PROGRESS, ERROR)String"FINISHED"
createdAtHorário de criação do registroDatetime"01/01/2023 00:00:00.0000"
updatedAtHorário de atualização do registroDatetime"01/01/2023 00:00:00.0000"

Exemplo​

{
  "id": "bc1bc4ea-8964-4bb7-97cc-2d77d39908d8",
  "status": 0,
  "statusDesc": "RECEIVED",
  "createdAt": "2022-10-14 14:38:50.045316",
  "updatedAt": "2022-10-14 14:38:50.045316"
}